Interactivity API: update TS/JSDocs after migrating to the new store() API
#56748
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DAreRodz
added
[Type] Developer Documentation
|
Size Change: +434 B (0%) Total Size: 1.72 MB
ℹ️ View Unchanged
|
21 tasks
|
Flaky tests detected in 118617c. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/7103870658
|
|
@DAreRodz is this ready for review? It seems like the e2e tests are failing. |
It is ready, although I'm looking at the errors now. Tests seem to be failing consistently. |
Turns out I included a bug while refactoring the Glad the tests alerted us. 😄 |
SantosGuillamot
approved these changes
Dec 5, 2023
cbravobernal
added
the
Backport to Gutenberg RC
|
@vcanales can we include this PR into 17.2? Thanks in advance! |
vcanales
pushed a commit
that referenced
this pull request
Dec 5, 2023
…()` API (#56748) * Update tsdocs for `store()` * Fix TS errors in hooks.tsx * Minor changes to context types * Rename DirectiveCallback params to args * Update directive() tsdocs * Add tsdocs for `getContext` and `getElement` * Add jsdocs for `navigate` and `prefetch` * Fix previousScope ref and state * Remove unnecessary `!` operator * Add removed comments for `DirectiveArgs` * Fix example format in `directive()`
|
Backported to 17.2 RC |
vcanales
removed
the
Backport to Gutenberg RC
cbravobernal
pushed a commit
that referenced
this pull request
Dec 7, 2023
…()` API (#56748) * Update tsdocs for `store()` * Fix TS errors in hooks.tsx * Minor changes to context types * Rename DirectiveCallback params to args * Update directive() tsdocs * Add tsdocs for `getContext` and `getElement` * Add jsdocs for `navigate` and `prefetch` * Fix previousScope ref and state * Remove unnecessary `!` operator * Add removed comments for `DirectiveArgs` * Fix example format in `directive()`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Tracking issue: #53740
Update comments describing the public API of the Interactivity API package. More precisely, these function comments have been updated:
store(),directive()getContext(),getElement(),navigate(),prefetch()Why?
The migration to the new
store()API introduced breaking changes, making these APIs different.How?
Updating docs to reflect the new API usage.